home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsIPrefLocalizedString.idl < prev    next >
Text File  |  2006-05-08  |  4KB  |  105 lines
  1. /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: NPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Netscape Public License
  6.  * Version 1.1 (the "License"); you may not use this file except in
  7.  * compliance with the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/NPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is Mozilla Communicator client code.
  16.  *
  17.  * The Initial Developer of the Original Code is 
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 1998
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  * Alec Flett <alecf@netscape.com>
  24.  * Brian Nesse <bnesse@netscape.com>
  25.  *
  26.  * Alternatively, the contents of this file may be used under the terms of
  27.  * either the GNU General Public License Version 2 or later (the "GPL"), or 
  28.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29.  * in which case the provisions of the GPL or the LGPL are applicable instead
  30.  * of those above. If you wish to allow use of your version of this file only
  31.  * under the terms of either the GPL or the LGPL, and not to allow others to
  32.  * use your version of this file under the terms of the NPL, indicate your
  33.  * decision by deleting the provisions above and replace them with the notice
  34.  * and other provisions required by the GPL or the LGPL. If you do not delete
  35.  * the provisions above, a recipient may use your version of this file under
  36.  * the terms of any one of the NPL, the GPL or the LGPL.
  37.  *
  38.  * ***** END LICENSE BLOCK ***** */
  39.  
  40. #include "nsISupports.idl"
  41.  
  42. /**
  43.  * The nsIPrefLocalizedString interface is simply a wrapper interface for
  44.  * nsISupportsString so the preferences service can have a unique identifier
  45.  * to distinguish between requests for normal wide strings (nsISupportsString)
  46.  * and "localized" wide strings, which get their default values from properites
  47.  * files.
  48.  *
  49.  * @see nsIPrefBranch
  50.  * @see nsISupportsString
  51.  * 
  52.  * @status FROZEN
  53.  */
  54.  
  55. [scriptable, uuid(ae419e24-1dd1-11b2-b39a-d3e5e7073802)]
  56. interface nsIPrefLocalizedString : nsISupports
  57. {
  58.   /**
  59.    * Provides access to string data stored in this property.
  60.    *
  61.    * @return NS_OK The operation succeeded.
  62.    * @return Other An error occured.
  63.    */
  64.   attribute wstring data;
  65.  
  66.   /**
  67.    * Used to retrieve the contents of this object into a wide string.
  68.    *
  69.    * @return wstring The string containing the data stored within this object.
  70.    */
  71.   wstring toString();
  72.  
  73.   /**
  74.    * Used to set the contents of this object.
  75.    *
  76.    * @param length The length of the string. This value should not include
  77.    *               space for the null terminator, nor should it account for the
  78.    *               size of a character. It should  only be the number of
  79.    *               characters for which there is space in the string.
  80.    * @param data   The string data to be stored.
  81.    *
  82.    * @note
  83.    * This makes a copy of the string argument passed in.
  84.    *
  85.    * @return NS_OK The data was successfully stored.
  86.    */
  87.   void setDataWithLength(in unsigned long length,
  88.                          [size_is(length)] in wstring data);
  89. };
  90.  
  91. %{C++
  92.  
  93. #define NS_PREFLOCALIZEDSTRING_CID                     \
  94.   { /* {064d9cee-1dd2-11b2-83e3-d25ab0193c26} */       \
  95.     0x064d9cee,                                        \
  96.     0x1dd2,                                            \
  97.     0x11b2,                                            \
  98.     { 0x83, 0xe3, 0xd2, 0x5a, 0xb0, 0x19, 0x3c, 0x26 } \
  99.   }
  100.  
  101. #define NS_PREFLOCALIZEDSTRING_CONTRACTID "@mozilla.org/pref-localizedstring;1"
  102. #define NS_PREFLOCALIZEDSTRING_CLASSNAME "Pref LocalizedString"
  103.  
  104. %}
  105.